/*
 * Copyright 2021 The Backstage Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Schema } from 'jsonschema';
import { createApiRef } from '@backstage/core-plugin-api';
import { Observable } from '@backstage/types';

/** @public */
export interface ConfigSchemaResult {
  schema?: Schema;
}

/** @public */
export interface ConfigSchemaApi {
  schema$(): Observable<ConfigSchemaResult>;
}

/** @public */
export const configSchemaApiRef = createApiRef<ConfigSchemaApi>({
  id: 'plugin.config-schema',
});
